Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Business Partner KIT]: removed open api plugin usage #1020

Merged

Conversation

SujitMBRDI
Copy link
Contributor

Description

With this pull request, removed open api plugin usage for business patner kit and also removed unnecessary .mdx files. We have added hyperlink of swagger documentation for each service from bpdm in business partner kit's development view which make kit more readable.

Fix #971

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@SujitMBRDI
Copy link
Contributor Author

Hi @jSchuetz88 @danielmiehle , could you please check pull request as waiting from long time.

Copy link
Member

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @SujitMBRDI,

thank you for removing the API. I actually like the idea, to update the references to the SwaggerHub UI instead of removing them completely. Unfortunately, the links to SwaggerHub don't work right now, but that should be automatically fixed, after the merge and automated scan of the openAPIs.

Only one change request (@danielmiehle please correct me here if I'm wrong): But the references also need to be removed from previous versions and not only for the "next" release. Otherwise we won't be able to get rid of the plugin.

@SujitMBRDI
Copy link
Contributor Author

Hi @SujitMBRDI,

thank you for removing the API. I actually like the idea, to update the references to the SwaggerHub UI instead of removing them completely. Unfortunately, the links to SwaggerHub don't work right now, but that should be automatically fixed, after the merge and automated scan of the openAPIs.

Only one change request (@danielmiehle please correct me here if I'm wrong): But the references also need to be removed from previous versions and not only for the "next" release. Otherwise we won't be able to get rid of the plugin.

Hi @jSchuetz88,

Thank you for reviewing the changes. Good to hear that you like the idea where we are linking api-hub swagger documentation for development view. Also you are right, the links will work after merge and once automated scan for OpenApi finish. I have provided link based on expected result of auto scan(it is high guess from our side).
So, there are high chances that I need to put another pull request if links appear differently on api-hub.
The reason why, i want this pull request to reviewed and merge first. In my second pull request(which i shall raise after scan results) i shall update links for swagger documentation if they are wrong for next version and will also make changes for previous release versions. I hope @danielmiehle, @jSchuetz88 and @maximilianong will agree to this approach.

@stephanbcbauer
Copy link
Member

IP Ticket created

@stephanbcbauer
Copy link
Member

@jSchuetz88 IP Ticket is still under review

@SujitMBRDI
Copy link
Contributor Author

Hi @jSchuetz88, @stephanbcbauer I can see the IP ticket is approved as well.

@SujitMBRDI SujitMBRDI requested a review from jSchuetz88 October 28, 2024 06:22
Copy link
Contributor

@arnoweiss arnoweiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@arnoweiss arnoweiss merged commit 94a3944 into eclipse-tractusx:main Nov 12, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Business Partner KIT] Remove API Plug-In
4 participants